home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_emacs.idb / usr / freeware / share / emacs / 19.34 / lisp / isearch.el.z / isearch.el
Encoding:
Text File  |  1998-10-28  |  50.2 KB  |  1,441 lines
  1. ;;; isearch.el --- incremental search minor mode.
  2.  
  3. ;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Daniel LaLiberte <liberte@cs.uiuc.edu>
  6. ;; Maintainer: FSF
  7.  
  8. ;; This file is part of GNU Emacs.
  9.  
  10. ;; GNU Emacs is free software; you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation; either version 2, or (at your option)
  13. ;; any later version.
  14.  
  15. ;; GNU Emacs is distributed in the hope that it will be useful,
  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. ;; GNU General Public License for more details.
  19.  
  20. ;; You should have received a copy of the GNU General Public License
  21. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23. ;; Boston, MA 02111-1307, USA.
  24.  
  25. ;;; Commentary:
  26.  
  27. ;; Instructions
  28.  
  29. ;; For programmed use of isearch-mode, e.g. calling (isearch-forward),
  30. ;; isearch-mode behaves modally and does not return until the search
  31. ;; is completed.  It uses a recursive-edit to behave this way.  Note:
  32. ;; gnus does it wrong: (call-interactively 'isearch-forward).
  33.  
  34. ;; The key bindings active within isearch-mode are defined below in
  35. ;; `isearch-mode-map' which is given bindings close to the default
  36. ;; characters of the original isearch.el.  With `isearch-mode',
  37. ;; however, you can bind multi-character keys and it should be easier
  38. ;; to add new commands.  One bug though: keys with meta-prefix cannot
  39. ;; be longer than two chars.  Also see minibuffer-local-isearch-map
  40. ;; for bindings active during `isearch-edit-string'.
  41.  
  42. ;; Note to emacs version 19 users: isearch-mode should work even if
  43. ;; you switch windows with the mouse, in which case isearch-mode is
  44. ;; terminated automatically before the switch.  This is true of lemacs
  45. ;; too, with a few more cleanups I've neglected in this release. 
  46. ;; No one has supplied patches for epoch yet.
  47.  
  48. ;; The search ring and completion commands automatically put you in
  49. ;; the minibuffer to edit the string.  This gives you a chance to
  50. ;; modify the search string before executing the search.  There are
  51. ;; three commands to terminate the editing: C-s and C-r exit the
  52. ;; minibuffer and search forward and reverse respectively, while C-m
  53. ;; exits and does a nonincremental search.
  54.  
  55. ;; Exiting immediately from isearch uses isearch-edit-string instead
  56. ;; of nonincremental-search, if search-nonincremental-instead is non-nil.
  57. ;; The name of this option should probably be changed if we decide to
  58. ;; keep the behavior.  No point in forcing nonincremental search until
  59. ;; the last possible moment.
  60.  
  61. ;; TODO
  62. ;; - Integrate the emacs 19 generalized command history.
  63. ;; - Think about incorporating query-replace.
  64. ;; - Hooks and options for failed search.
  65.  
  66. ;;; Change Log:
  67.  
  68. ;; Changes before those recorded in ChangeLog:
  69.  
  70. ;; Revision 1.4  92/09/14  16:26:02  liberte
  71. ;; Added prefix args to isearch-forward, etc. to switch between
  72. ;;    string and regular expression searching.
  73. ;; Added some support for lemacs.
  74. ;; Added general isearch-highlight option - but only for lemacs so far.
  75. ;; Added support for frame switching in emacs 19.
  76. ;; Added word search option to isearch-edit-string.
  77. ;; Renamed isearch-quit to isearch-abort.
  78. ;; Numerous changes to comments and doc strings.
  79. ;; 
  80. ;; Revision 1.3  92/06/29  13:10:08  liberte
  81. ;; Moved modal isearch-mode handling into isearch-mode.
  82. ;; Got rid of buffer-local isearch variables.
  83. ;; isearch-edit-string used by ring adjustments, completion, and
  84. ;; nonincremental searching.  C-s and C-r are additional exit commands.
  85. ;; Renamed all regex to regexp.
  86. ;; Got rid of found-start and found-point globals.
  87. ;; Generalized handling of upper-case chars.
  88.  
  89. ;; Revision 1.2  92/05/27  11:33:57  liberte
  90. ;; Emacs version 19 has a search ring, which is supported here.
  91. ;; Other fixes found in the version 19 isearch are included here.
  92. ;;
  93. ;; Also see variables search-caps-disable-folding,
  94. ;; search-nonincremental-instead, search-whitespace-regexp, and
  95. ;; commands isearch-toggle-regexp, isearch-edit-string.
  96. ;;
  97. ;; semi-modal isearching is supported.
  98.  
  99. ;; Changes for 1.1
  100. ;; 3/18/92 Fixed invalid-regexp.
  101. ;; 3/18/92 Fixed yanking in regexps.
  102.  
  103. ;;; Code:
  104.  
  105.  
  106. ;;; Some additional options and constants.
  107.  
  108. (defconst search-exit-option t
  109.   "*Non-nil means random control characters terminate incremental search.")
  110.  
  111. (defvar search-slow-window-lines 1
  112.   "*Number of lines in slow search display windows.
  113. These are the short windows used during incremental search on slow terminals.
  114. Negative means put the slow search window at the top (normally it's at bottom)
  115. and the value is minus the number of lines.")
  116.  
  117. (defvar search-slow-speed 1200
  118.   "*Highest terminal speed at which to use \"slow\" style incremental search.
  119. This is the style where a one-line window is created to show the line
  120. that the search has reached.")
  121.  
  122. (defvar search-upper-case 'not-yanks
  123.   "*If non-nil, upper case chars disable case fold searching.
  124. That is, upper and lower case chars must match exactly.
  125. This applies no matter where the chars come from, but does not
  126. apply to chars in regexps that are prefixed with `\\'.
  127. If this value is `not-yanks', yanked text is always downcased.")
  128.  
  129. (defvar search-nonincremental-instead t
  130.   "*If non-nil, do a nonincremental search instead if exiting immediately.
  131. Actually, `isearch-edit-string' is called to let you enter the search
  132. string, and RET terminates editing and does a nonincremental search.")
  133.  
  134. (defconst search-whitespace-regexp "\\s-+"
  135.   "*If non-nil, regular expression to match a sequence of whitespace chars.
  136. You might want to use something like \"[ \\t\\r\\n]+\" instead.")
  137.  
  138. (defvar search-highlight nil
  139.   "*Non-nil means incremental search highlights the current match.")
  140.  
  141. (defvar isearch-mode-hook nil
  142.   "Function(s) to call after starting up an incremental search.")
  143.  
  144. (defvar isearch-mode-end-hook nil
  145.   "Function(s) to call after terminating an incremental search.")
  146.  
  147. ;;; Search ring.
  148.  
  149. (defvar search-ring nil
  150.   "List of search string sequences.")
  151. (defvar regexp-search-ring nil
  152.   "List of regular expression search string sequences.")
  153.  
  154. (defconst search-ring-max 16
  155.   "*Maximum length of search ring before oldest elements are thrown away.")
  156. (defconst regexp-search-ring-max 16
  157.   "*Maximum length of regexp search ring before oldest elements are thrown away.")
  158.  
  159. (defvar search-ring-yank-pointer nil
  160.   "Index in `search-ring' of last string reused.
  161. nil if none yet.")
  162. (defvar regexp-search-ring-yank-pointer nil
  163.   "Index in `regexp-search-ring' of last string reused.
  164. nil if none yet.")
  165.  
  166. (defvar search-ring-update nil
  167.   "*Non-nil if advancing or retreating in the search ring should cause search.
  168. Default value, nil, means edit the string instead.")
  169.  
  170. ;;; Define isearch-mode keymap.
  171.  
  172. (defvar isearch-mode-map nil
  173.   "Keymap for isearch-mode.")
  174.  
  175. (or isearch-mode-map
  176.     (let* ((i 0)
  177.        (map (make-keymap)))
  178.       (or (vectorp (nth 1 map))
  179.       (error "The initialization of isearch-mode-map must be updated"))
  180.       ;; Give this map a vector 256 long, for dense binding
  181.       ;; of a larger range of ordinary characters.
  182.       (setcar (cdr map) (make-vector 256 nil))
  183.  
  184.       ;; Make function keys, etc, exit the search.
  185.       (define-key map [t] 'isearch-other-control-char)
  186.       ;; Control chars, by default, end isearch mode transparently.
  187.       ;; We need these explicit definitions because, in a dense keymap, 
  188.       ;; the binding for t does not affect characters.
  189.       ;; We use a dense keymap to save space.
  190.       (while (< i ?\ )
  191.     (define-key map (make-string 1 i) 'isearch-other-control-char)
  192.     (setq i (1+ i)))
  193.  
  194.       ;; Printing chars extend the search string by default.
  195.       (setq i ?\ )
  196.       (while (< i (length (nth 1 map)))
  197.     (define-key map (vector i) 'isearch-printing-char)
  198.     (setq i (1+ i)))
  199.  
  200.       ;; To handle local bindings with meta char prefix keys, define
  201.       ;; another full keymap.  This must be done for any other prefix
  202.       ;; keys as well, one full keymap per char of the prefix key.  It
  203.       ;; would be simpler to disable the global keymap, and/or have a
  204.       ;; default local key binding for any key not otherwise bound.
  205.       (let ((meta-map (make-sparse-keymap)))
  206.     (define-key map (char-to-string meta-prefix-char) meta-map)
  207.     (define-key map [escape] meta-map))
  208.       (define-key map (vector meta-prefix-char t) 'isearch-other-meta-char)
  209.  
  210.       ;; Several non-printing chars change the searching behavior.
  211.       (define-key map "\C-s" 'isearch-repeat-forward)
  212.       (define-key map "\C-r" 'isearch-repeat-backward)
  213.       (define-key map "\177" 'isearch-delete-char)
  214.       (define-key map "\C-g" 'isearch-abort)
  215.       ;; This assumes \e is the meta-prefix-char.
  216.       (or (= ?\e meta-prefix-char)
  217.       (error "Inconsistency in isearch.el"))
  218.       (define-key map "\e\e\e" 'isearch-cancel)
  219.       (define-key map  [escape escape escape] 'isearch-cancel)
  220.     
  221.       (define-key map "\C-q" 'isearch-quote-char)
  222.  
  223.       (define-key map "\r" 'isearch-exit)
  224.       (define-key map "\C-j" 'isearch-printing-char)
  225.       (define-key map "\t" 'isearch-printing-char)
  226.       (define-key map " " 'isearch-whitespace-chars)
  227.     
  228.       (define-key map "\C-w" 'isearch-yank-word)
  229.       (define-key map "\C-y" 'isearch-yank-line)
  230.  
  231.       ;; Define keys for regexp chars * ? |.
  232.       ;; Nothing special for + because it matches at least once.
  233.       (define-key map "*" 'isearch-*-char)
  234.       (define-key map "?" 'isearch-*-char)
  235.       (define-key map "|" 'isearch-|-char)
  236.  
  237. ;;; Turned off because I find I expect to get the global definition--rms.
  238. ;;;      ;; Instead bind C-h to special help command for isearch-mode.
  239. ;;;      (define-key map "\C-h" 'isearch-mode-help)
  240.  
  241.       (define-key map "\M-n" 'isearch-ring-advance)
  242.       (define-key map "\M-p" 'isearch-ring-retreat)
  243.       (define-key map "\M-y" 'isearch-yank-kill)
  244.  
  245.       (define-key map "\M-\t" 'isearch-complete)
  246.  
  247.       ;; Pass frame events transparently so they won't exit the search.
  248.       ;; In particular, if we have more than one display open, then a
  249.       ;; switch-frame might be generated by someone typing at another keyboard.
  250.       (define-key map [switch-frame] nil)
  251.       (define-key map [delete-frame] nil)
  252.       (define-key map [iconify-frame] nil)
  253.       (define-key map [make-frame-visible] nil)
  254.  
  255.       (setq isearch-mode-map map)
  256.       ))
  257.  
  258. ;; Some bindings you may want to put in your isearch-mode-hook.
  259. ;; Suggest some alternates...
  260. ;; (define-key isearch-mode-map "\C-t" 'isearch-toggle-case-fold)
  261. ;; (define-key isearch-mode-map "\C-t" 'isearch-toggle-regexp)
  262. ;; (define-key isearch-mode-map "\C-^" 'isearch-edit-string)
  263.  
  264.  
  265. (defvar minibuffer-local-isearch-map nil
  266.   "Keymap for editing isearch strings in the minibuffer.")
  267.  
  268. (or minibuffer-local-isearch-map
  269.     (let ((map (copy-keymap minibuffer-local-map)))
  270.       (define-key map "\r" 'isearch-nonincremental-exit-minibuffer)
  271.       (define-key map "\M-n" 'isearch-ring-advance-edit)
  272.       (define-key map "\M-p" 'isearch-ring-retreat-edit)
  273.       (define-key map "\M-\t" 'isearch-complete-edit)
  274.       (define-key map "\C-s" 'isearch-forward-exit-minibuffer)
  275.       (define-key map "\C-r" 'isearch-reverse-exit-minibuffer)
  276.       (setq minibuffer-local-isearch-map map)
  277.       ))
  278.  
  279. ;; Internal variables declared globally for byte-compiler.
  280. ;; These are all set with setq while isearching
  281. ;; and bound locally while editing the search string.
  282.  
  283. (defvar isearch-forward nil)    ; Searching in the forward direction.
  284. (defvar isearch-regexp nil)    ; Searching for a regexp.
  285. (defvar isearch-word nil)    ; Searching for words.
  286.  
  287. (defvar isearch-cmds nil)   ; Stack of search status sets.
  288. (defvar isearch-string "")  ; The current search string.
  289. (defvar isearch-message "") ; text-char-description version of isearch-string
  290.  
  291. (defvar isearch-success t)        ; Searching is currently successful.
  292. (defvar isearch-invalid-regexp nil)    ; Regexp not well formed.
  293. (defvar isearch-within-brackets nil)    ; Regexp has unclosed [.
  294. (defvar isearch-other-end nil)    ; Start (end) of match if forward (backward).
  295. (defvar isearch-wrapped nil)    ; Searching restarted from the top (bottom).
  296. (defvar isearch-barrier 0)
  297. (defvar isearch-just-started nil)
  298.  
  299. ; case-fold-search while searching.
  300. ;   either nil, t, or 'yes.  'yes means the same as t except that mixed
  301. ;   case in the search string is ignored.
  302. (defvar isearch-case-fold-search nil)
  303.  
  304. (defvar isearch-adjusted nil)
  305. (defvar isearch-slow-terminal-mode nil)
  306. ;;; If t, using a small window.
  307. (defvar isearch-small-window nil)
  308. (defvar isearch-opoint 0)
  309. ;;; The window configuration active at the beginning of the search.
  310. (defvar isearch-window-configuration nil)
  311.  
  312. ;; Flag to indicate a yank occurred, so don't move the cursor.
  313. (defvar isearch-yank-flag nil)
  314.  
  315. ;;; A function to be called after each input character is processed.
  316. ;;; (It is not called after characters that exit the search.)
  317. ;;; It is only set from an optional argument to `isearch-mode'.
  318. (defvar isearch-op-fun nil)
  319.  
  320. ;;;  Is isearch-mode in a recursive edit for modal searching.
  321. (defvar isearch-recursive-edit nil)
  322.  
  323. ;;; Should isearch be terminated after doing one search?
  324. (defvar isearch-nonincremental nil)
  325.  
  326. ;; New value of isearch-forward after isearch-edit-string.
  327. (defvar isearch-new-forward nil)
  328.  
  329.  
  330. ;; Minor-mode-alist changes - kind of redundant with the
  331. ;; echo area, but if isearching in multiple windows, it can be useful.
  332.  
  333. (or (assq 'isearch-mode minor-mode-alist)
  334.     (nconc minor-mode-alist
  335.        (list '(isearch-mode isearch-mode))))
  336.  
  337. (defvar isearch-mode nil) ;; Name of the minor mode, if non-nil.
  338. (make-variable-buffer-local 'isearch-mode)
  339.  
  340. (define-key global-map "\C-s" 'isearch-forward)
  341. (define-key esc-map "\C-s" 'isearch-forward-regexp)
  342. (define-key global-map "\C-r" 'isearch-backward)
  343. (define-key esc-map "\C-r" 'isearch-backward-regexp)
  344.  
  345. ;;; Entry points to isearch-mode.
  346. ;;; These four functions should replace those in loaddefs.el
  347. ;;; An alternative is to defalias isearch-forward etc to isearch-mode,
  348. ;;; and look at this-command to set the options accordingly.
  349.  
  350. (defun isearch-forward (&optional regexp-p no-recursive-edit)
  351.   "\
  352. Do incremental search forward.
  353. With a prefix argument, do an incremental regular expression search instead.
  354. \\<isearch-mode-map>
  355. As you type characters, they add to the search string and are found.
  356. The following non-printing keys are bound in `isearch-mode-map'.  
  357.  
  358. Type \\[isearch-delete-char] to cancel characters from end of search string.
  359. Type \\[isearch-exit] to exit, leaving point at location found.
  360. Type LFD (C-j) to match end of line.
  361. Type \\[isearch-repeat-forward] to search again forward,\
  362.  \\[isearch-repeat-backward] to search again backward.
  363. Type \\[isearch-yank-word] to yank word from buffer onto end of search\
  364.  string and search for it.
  365. Type \\[isearch-yank-line] to yank rest of line onto end of search string\
  366.  and search for it.
  367. Type \\[isearch-quote-char] to quote control character to search for it.
  368. \\[isearch-abort] while searching or when search has failed cancels input\
  369.  back to what has
  370.  been found successfully.
  371. \\[isearch-abort] when search is successful aborts and moves point to\
  372.  starting point.
  373.  
  374. Also supported is a search ring of the previous 16 search strings.
  375. Type \\[isearch-ring-advance] to search for the next item in the search ring.
  376. Type \\[isearch-ring-retreat] to search for the previous item in the search\
  377.  ring.
  378. Type \\[isearch-complete] to complete the search string using the search ring.
  379.  
  380. The above keys, bound in `isearch-mode-map', are often controlled by 
  381.  options; do M-x apropos on search-.* to find them.
  382. Other control and meta characters terminate the search
  383.  and are then executed normally (depending on `search-exit-option').
  384. Likewise for function keys and mouse button events.
  385.  
  386. If this function is called non-interactively, it does not return to
  387. the calling function until the search is done."
  388.  
  389.   (interactive "P\np")
  390.   (isearch-mode t (not (null regexp-p)) nil (not no-recursive-edit)))
  391.  
  392. (defun isearch-forward-regexp (&optional not-regexp no-recursive-edit)
  393.   "\
  394. Do incremental search forward for regular expression.
  395. With a prefix argument, do a regular string search instead.
  396. Like ordinary incremental search except that your input
  397. is treated as a regexp.  See \\[isearch-forward] for more info."
  398.   (interactive "P\np")
  399.   (isearch-mode t (null not-regexp) nil (not no-recursive-edit)))
  400.  
  401. (defun isearch-backward (&optional regexp-p no-recursive-edit)
  402.   "\
  403. Do incremental search backward.
  404. With a prefix argument, do a regular expression search instead.
  405. See \\[isearch-forward] for more information."
  406.   (interactive "P\np")
  407.   (isearch-mode nil (not (null regexp-p)) nil (not no-recursive-edit)))
  408.  
  409. (defun isearch-backward-regexp (&optional not-regexp no-recursive-edit)
  410.   "\
  411. Do incremental search backward for regular expression.
  412. With a prefix argument, do a regular string search instead.
  413. Like ordinary incremental search except that your input
  414. is treated as a regexp.  See \\[isearch-forward] for more info."
  415.   (interactive "P\np")
  416.   (isearch-mode nil (null not-regexp) nil (not no-recursive-edit)))
  417.  
  418.  
  419. (defun isearch-mode-help ()
  420.   (interactive)
  421.   (describe-function 'isearch-forward)
  422.   (isearch-update))
  423.  
  424.  
  425. ;; isearch-mode only sets up incremental search for the minor mode.
  426. ;; All the work is done by the isearch-mode commands.
  427.  
  428. ;; Not used yet:
  429. ;;(defconst isearch-commands '(isearch-forward isearch-backward
  430. ;;                 isearch-forward-regexp isearch-backward-regexp)
  431. ;;  "List of commands for which isearch-mode does not recursive-edit.")
  432.                  
  433.  
  434. (defun isearch-mode (forward &optional regexp op-fun recursive-edit word-p)
  435.   "Start isearch minor mode.  Called by `isearch-forward', etc.
  436.  
  437. \\{isearch-mode-map}"
  438.  
  439.   ;; Initialize global vars.
  440.   (setq isearch-forward forward
  441.     isearch-regexp regexp
  442.     isearch-word word-p
  443.     isearch-op-fun op-fun
  444.     isearch-case-fold-search case-fold-search
  445.     isearch-string ""
  446.     isearch-message ""
  447.     isearch-cmds nil
  448.     isearch-success t
  449.     isearch-wrapped nil
  450.     isearch-barrier (point)
  451.     isearch-adjusted nil
  452.     isearch-yank-flag nil
  453.     isearch-invalid-regexp nil
  454.     isearch-within-brackets nil
  455.     isearch-slow-terminal-mode (and (<= baud-rate search-slow-speed)
  456.                     (> (window-height)
  457.                        (* 4 search-slow-window-lines)))
  458.     isearch-other-end nil
  459.     isearch-small-window nil
  460.     isearch-just-started t
  461.  
  462.     isearch-opoint (point)
  463.     search-ring-yank-pointer nil
  464.     regexp-search-ring-yank-pointer nil)
  465.   (looking-at "")
  466.   (setq isearch-window-configuration
  467.     (if isearch-slow-terminal-mode (current-window-configuration) nil))
  468.  
  469.   (setq    isearch-mode " Isearch")  ;; forward? regexp?
  470.   (force-mode-line-update)
  471.  
  472.   (isearch-push-state)
  473.  
  474.   (setq overriding-terminal-local-map isearch-mode-map)
  475.   (isearch-update)
  476.   (run-hooks 'isearch-mode-hook)
  477.  
  478.   (add-hook 'mouse-leave-buffer-hook 'isearch-done)
  479.  
  480.   ;; isearch-mode can be made modal (in the sense of not returning to 
  481.   ;; the calling function until searching is completed) by entering 
  482.   ;; a recursive-edit and exiting it when done isearching.
  483.   (if recursive-edit
  484.       (let ((isearch-recursive-edit t))
  485.     (recursive-edit)))
  486.   isearch-success)
  487.  
  488.  
  489. ;; Some high level utilities.  Others below.
  490.  
  491. (defun isearch-update ()
  492.   ;; Called after each command to update the display.  
  493.   (if (null unread-command-events)
  494.       (progn
  495.     (if (not (input-pending-p))
  496.         (isearch-message))
  497.     (if (and isearch-slow-terminal-mode
  498.          (not (or isearch-small-window 
  499.               (pos-visible-in-window-p))))
  500.         (let ((found-point (point)))
  501.           (setq isearch-small-window t)
  502.           (move-to-window-line 0)
  503.           (let ((window-min-height 1))
  504.         (split-window nil (if (< search-slow-window-lines 0)
  505.                       (1+ (- search-slow-window-lines))
  506.                     (- (window-height)
  507.                        (1+ search-slow-window-lines)))))
  508.           (if (< search-slow-window-lines 0)
  509.           (progn (vertical-motion (- 1 search-slow-window-lines))
  510.              (set-window-start (next-window) (point))
  511.              (set-window-hscroll (next-window)
  512.                          (window-hscroll))
  513.              (set-window-hscroll (selected-window) 0))
  514.         (other-window 1))
  515.           (goto-char found-point)))
  516.     (if isearch-other-end
  517.         (if (< isearch-other-end (point)) ; isearch-forward?
  518.         (isearch-highlight isearch-other-end (point))
  519.           (isearch-highlight (point) isearch-other-end))
  520.       (isearch-dehighlight nil))
  521.     ))
  522.   (setq ;; quit-flag nil  not for isearch-mode
  523.    isearch-adjusted nil
  524.    isearch-yank-flag nil)
  525.   )
  526.  
  527. (defun isearch-done (&optional nopush edit)
  528.   (remove-hook 'mouse-leave-buffer-hook 'isearch-done)
  529.   ;; Called by all commands that terminate isearch-mode.
  530.   ;; If NOPUSH is non-nil, we don't push the string on the search ring.
  531.   (setq overriding-terminal-local-map nil)
  532.   ;; (setq pre-command-hook isearch-old-pre-command-hook) ; for lemacs
  533.   (isearch-dehighlight t)
  534.   (let ((found-start (window-start (selected-window)))
  535.     (found-point (point)))
  536.     (if isearch-window-configuration
  537.     (set-window-configuration isearch-window-configuration))
  538.  
  539.     (if isearch-small-window
  540.     (goto-char found-point)
  541.       ;; Exiting the save-window-excursion clobbers window-start; restore it.
  542.       (set-window-start (selected-window) found-start t))
  543.  
  544.     ;; If there was movement, mark the starting position.
  545.     ;; Maybe should test difference between and set mark iff > threshold.
  546.     (if (/= (point) isearch-opoint)
  547.     (or (and transient-mark-mode mark-active)
  548.         (progn
  549.           (push-mark isearch-opoint t)
  550.           (or executing-kbd-macro (> (minibuffer-depth) 0)
  551.           (message "Mark saved where search started"))))))
  552.  
  553.   (setq isearch-mode nil)
  554.   (force-mode-line-update)
  555.  
  556.   (if (and (> (length isearch-string) 0) (not nopush))
  557.       ;; Update the ring data.
  558.       (isearch-update-ring isearch-string isearch-regexp))
  559.  
  560.   (run-hooks 'isearch-mode-end-hook)
  561.   (and (not edit) isearch-recursive-edit (exit-recursive-edit)))
  562.  
  563. (defun isearch-update-ring (string &optional regexp)
  564.   "Add STRING to the beginning of the search ring.
  565. REGEXP says which ring to use."
  566.   (if regexp 
  567.       (if (or (null regexp-search-ring)
  568.           (not (string= string (car regexp-search-ring))))
  569.       (progn
  570.         (setq regexp-search-ring
  571.           (cons string regexp-search-ring))
  572.         (if (> (length regexp-search-ring) regexp-search-ring-max)
  573.         (setcdr (nthcdr (1- search-ring-max) regexp-search-ring)
  574.             nil))))
  575.     (if (or (null search-ring)
  576.         (not (string= string (car search-ring))))
  577.     (progn
  578.       (setq search-ring (cons string search-ring))
  579.       (if (> (length search-ring) search-ring-max)
  580.           (setcdr (nthcdr (1- search-ring-max) search-ring) nil))))))
  581.  
  582. ;;; Switching buffers should first terminate isearch-mode.
  583. ;;; This is done quite differently for each variant of emacs.
  584. ;;; For lemacs, see Exiting in lemacs below
  585.  
  586. ;; For Emacs 19, the frame switch event is handled.
  587. (defun isearch-switch-frame-handler ()
  588.   (interactive) ;; Is this necessary?
  589.   ;; First terminate isearch-mode.
  590.   (isearch-done)
  591.   (handle-switch-frame (car (cdr (isearch-last-command-char)))))
  592.  
  593.  
  594. ;; Commands active while inside of the isearch minor mode.
  595.  
  596. (defun isearch-exit ()
  597.   "Exit search normally.
  598. However, if this is the first command after starting incremental
  599. search and `search-nonincremental-instead' is non-nil, do a
  600. nonincremental search instead via `isearch-edit-string'."
  601.   (interactive)
  602.   (if (and search-nonincremental-instead 
  603.        (= 0 (length isearch-string)))
  604.       (let ((isearch-nonincremental t))
  605.     (isearch-edit-string)))
  606.   (isearch-done))
  607.  
  608.  
  609. (defun isearch-edit-string ()
  610.   "Edit the search string in the minibuffer.
  611. The following additional command keys are active while editing.
  612. \\<minibuffer-local-isearch-map>
  613. \\[exit-minibuffer] to resume incremental searching with the edited string.
  614. \\[isearch-nonincremental-exit-minibuffer] to do one nonincremental search.
  615. \\[isearch-forward-exit-minibuffer] to resume isearching forward.
  616. \\[isearch-reverse-exit-minibuffer] to resume isearching backward.
  617. \\[isearch-ring-advance-edit] to replace the search string with the next item in the search ring.
  618. \\[isearch-ring-retreat-edit] to replace the search string with the previous item in the search ring.
  619. \\[isearch-complete-edit] to complete the search string using the search ring.
  620. \\<isearch-mode-map>
  621. If first char entered is \\[isearch-yank-word], then do word search instead."
  622.  
  623.   ;; This code is very hairy for several reasons, explained in the code.
  624.   ;; Mainly, isearch-mode must be terminated while editing and then restarted.
  625.   ;; If there were a way to catch any change of buffer from the minibuffer,
  626.   ;; this could be simplified greatly.
  627.   ;; Editing doesn't back up the search point.  Should it?
  628.   (interactive)
  629.   (condition-case err
  630.       (let ((isearch-nonincremental isearch-nonincremental)
  631.  
  632.         ;; Locally bind all isearch global variables to protect them
  633.         ;; from recursive isearching.
  634.         ;; isearch-string -message and -forward are not bound
  635.         ;; so they may be changed.  Instead, save the values.
  636.         (isearch-new-string isearch-string)
  637.         (isearch-new-message isearch-message)
  638.         (isearch-new-forward isearch-forward)
  639.         (isearch-new-word isearch-word)
  640.  
  641.         (isearch-regexp isearch-regexp)
  642.         (isearch-op-fun isearch-op-fun)
  643.         (isearch-cmds isearch-cmds)
  644.         (isearch-success isearch-success)
  645.         (isearch-wrapped isearch-wrapped)
  646.         (isearch-barrier isearch-barrier)
  647.         (isearch-adjusted isearch-adjusted)
  648.         (isearch-yank-flag isearch-yank-flag)
  649.         (isearch-invalid-regexp isearch-invalid-regexp)
  650.         (isearch-within-brackets isearch-within-brackets)
  651. ;;; Don't bind this.  We want isearch-search, below, to set it.
  652. ;;; And the old value won't matter after that.
  653. ;;;        (isearch-other-end isearch-other-end)
  654. ;;; Perhaps some of these other variables should be bound for a
  655. ;;; shorter period, ending before the next isearch-search.
  656. ;;; But there doesn't seem to be a real bug, so let's not risk it now.
  657.         (isearch-opoint isearch-opoint)
  658.         (isearch-slow-terminal-mode isearch-slow-terminal-mode)
  659.         (isearch-small-window isearch-small-window)
  660.         (isearch-recursive-edit isearch-recursive-edit)
  661.         ;; Save current configuration so we can restore it here.
  662.         (isearch-window-configuration (current-window-configuration))
  663.         )
  664.  
  665.     ;; Actually terminate isearching until editing is done.
  666.     ;; This is so that the user can do anything without failure, 
  667.     ;; like switch buffers and start another isearch, and return.
  668.     (condition-case err
  669.         (isearch-done t t)
  670.       (exit nil))            ; was recursive editing
  671.  
  672.     (isearch-message) ;; for read-char
  673.     (unwind-protect
  674.         (let* (;; Why does following read-char echo?  
  675.            ;;(echo-keystrokes 0) ;; not needed with above message
  676.            (e (let ((cursor-in-echo-area t))
  677.             (read-event)))
  678.            ;; Binding minibuffer-history-symbol to nil is a work-around
  679.            ;; for some incompatibility with gmhist.
  680.            (minibuffer-history-symbol)
  681.            (message-log-max nil))
  682.           ;; If the first character the user types when we prompt them
  683.           ;; for a string is the yank-word character, then go into
  684.           ;; word-search mode.  Otherwise unread that character and
  685.           ;; read a key the normal way.
  686.           ;; Word search does not apply (yet) to regexp searches,
  687.           ;; no check is made here.
  688.           (message (isearch-message-prefix nil nil t))
  689.           (if (eq 'isearch-yank-word
  690.               (lookup-key isearch-mode-map (vector e)))
  691.           (setq isearch-word t  ;; so message-prefix is right
  692.             isearch-new-word t)
  693.         (isearch-unread e))
  694.           (setq cursor-in-echo-area nil)
  695.           (setq isearch-new-string
  696.             (let (junk-ring)
  697.               (read-from-minibuffer
  698.                 (isearch-message-prefix nil nil isearch-nonincremental)
  699.                isearch-string
  700.                minibuffer-local-isearch-map nil
  701.                'junk-ring))
  702.             isearch-new-message
  703.             (mapconcat 'isearch-text-char-description
  704.                    isearch-new-string "")))
  705.       ;; Always resume isearching by restarting it.
  706.       (isearch-mode isearch-forward 
  707.             isearch-regexp 
  708.             isearch-op-fun 
  709.             nil
  710.             isearch-word)
  711.  
  712.       ;; Copy new local values to isearch globals
  713.       (setq isearch-string isearch-new-string
  714.         isearch-message isearch-new-message
  715.         isearch-forward isearch-new-forward
  716.         isearch-word isearch-new-word))
  717.  
  718.     ;; Empty isearch-string means use default.
  719.     (if (= 0 (length isearch-string))
  720.         (setq isearch-string (or (car (if isearch-regexp
  721.                           regexp-search-ring
  722.                         search-ring))
  723.                      ""))
  724.       ;; This used to set the last search string,
  725.       ;; but I think it is not right to do that here.
  726.       ;; Only the string actually used should be saved.
  727.       )
  728.  
  729.     ;; Reinvoke the pending search.
  730.     (isearch-push-state)
  731.     (isearch-search)
  732.     (isearch-update)
  733.     (if isearch-nonincremental 
  734.         (progn
  735.           ;; (sit-for 1) ;; needed if isearch-done does: (message "")
  736.           (isearch-done))))
  737.  
  738.     (quit  ; handle abort-recursive-edit
  739.      (isearch-abort)  ;; outside of let to restore outside global values
  740.      )))
  741.  
  742. (defun isearch-nonincremental-exit-minibuffer ()
  743.   (interactive)
  744.   (setq isearch-nonincremental t)
  745.   (exit-minibuffer))
  746.  
  747. (defun isearch-forward-exit-minibuffer ()
  748.   (interactive)
  749.   (setq isearch-new-forward t)
  750.   (exit-minibuffer))
  751.  
  752. (defun isearch-reverse-exit-minibuffer ()
  753.   (interactive)
  754.   (setq isearch-new-forward nil)
  755.   (exit-minibuffer))
  756.  
  757. (defun isearch-cancel ()
  758.   "Terminate the search and go back to the starting point."
  759.   (interactive)
  760.   (goto-char isearch-opoint)
  761.   (isearch-done t)
  762.   (signal 'quit nil))  ; and pass on quit signal
  763.  
  764. (defun isearch-abort ()
  765.   "Abort incremental search mode if searching is successful, signaling quit.
  766. Otherwise, revert to previous successful search and continue searching.
  767. Use `isearch-exit' to quit without signaling."
  768.   (interactive)
  769. ;;  (ding)  signal instead below, if quitting
  770.   (discard-input)
  771.   (if isearch-success
  772.       ;; If search is successful, move back to starting point
  773.       ;; and really do quit.
  774.       (progn (goto-char isearch-opoint)
  775.          (setq isearch-success nil)
  776.          (isearch-done t)   ; exit isearch
  777.          (signal 'quit nil))  ; and pass on quit signal
  778.     ;; If search is failing, or has an incomplete regexp,
  779.     ;; rub out until it is once more successful.
  780.     (while (or (not isearch-success) isearch-invalid-regexp)
  781.       (isearch-pop-state))
  782.     (isearch-update)))
  783.  
  784. (defun isearch-repeat (direction)
  785.   ;; Utility for isearch-repeat-forward and -backward.
  786.   (if (eq isearch-forward (eq direction 'forward))
  787.       ;; C-s in forward or C-r in reverse.
  788.       (if (equal isearch-string "")
  789.       ;; If search string is empty, use last one.
  790.       (setq isearch-string
  791.         (or (if isearch-regexp
  792.             (car regexp-search-ring)
  793.               (car search-ring))
  794.             "")
  795.         isearch-message
  796.         (mapconcat 'isearch-text-char-description
  797.                isearch-string ""))
  798.     ;; If already have what to search for, repeat it.
  799.     (or isearch-success
  800.         (progn 
  801.  
  802.           (goto-char (if isearch-forward (point-min) (point-max)))
  803.           (setq isearch-wrapped t))))
  804.     ;; C-s in reverse or C-r in forward, change direction.
  805.     (setq isearch-forward (not isearch-forward)))
  806.  
  807.   (setq isearch-barrier (point)) ; For subsequent \| if regexp.
  808.  
  809.   (if (equal isearch-string "")
  810.       (setq isearch-success t)
  811.     (if (and isearch-success (equal (match-end 0) (match-beginning 0))
  812.          (not isearch-just-started))
  813.     ;; If repeating a search that found
  814.     ;; an empty string, ensure we advance.
  815.     (if (if isearch-forward (eobp) (bobp))
  816.         ;; If there's nowhere to advance to, fail (and wrap next time).
  817.         (progn
  818.           (setq isearch-success nil)
  819.           (ding))
  820.       (forward-char (if isearch-forward 1 -1))
  821.       (isearch-search))
  822.       (isearch-search)))
  823.  
  824.   (isearch-push-state)
  825.   (isearch-update))
  826.  
  827. (defun isearch-repeat-forward ()
  828.   "Repeat incremental search forwards."
  829.   (interactive)
  830.   (isearch-repeat 'forward))
  831.  
  832. (defun isearch-repeat-backward ()
  833.   "Repeat incremental search backwards."
  834.   (interactive)
  835.   (isearch-repeat 'backward))
  836.  
  837. (defun isearch-toggle-regexp ()
  838.   "Toggle regexp searching on or off."
  839.   ;; The status stack is left unchanged.
  840.   (interactive)
  841.   (setq isearch-regexp (not isearch-regexp))
  842.   (if isearch-regexp (setq isearch-word nil))
  843.   (isearch-update))
  844.  
  845. (defun isearch-toggle-case-fold ()
  846.   "Toggle case folding in searching on or off."
  847.   (interactive)
  848.   (setq isearch-case-fold-search
  849.     (if isearch-case-fold-search nil 'yes))
  850.   (let ((message-log-max nil))
  851.     (message "%s%s [case %ssensitive]"
  852.          (isearch-message-prefix nil nil isearch-nonincremental)
  853.          isearch-message
  854.          (if isearch-case-fold-search "in" "")))
  855.   (setq isearch-adjusted t)
  856.   (sit-for 1)
  857.   (isearch-update))
  858.  
  859. (defun isearch-delete-char ()
  860.   "Discard last input item and move point back.  
  861. If no previous match was done, just beep."
  862.   (interactive)
  863.   (if (null (cdr isearch-cmds))
  864.       (ding)
  865.     (isearch-pop-state))
  866.   (isearch-update))
  867.  
  868.  
  869. (defun isearch-yank (chunk)
  870.   ;; Helper for isearch-yank-word and isearch-yank-line
  871.   ;; CHUNK should be word, line or kill.
  872.   (let ((string (cond
  873.                  ((eq chunk 'kill)
  874.                   (current-kill 0))
  875.                  (t
  876.           (save-excursion
  877.             (and (not isearch-forward) isearch-other-end
  878.              (goto-char isearch-other-end))
  879.             (buffer-substring
  880.              (point)
  881.              (save-excursion
  882.                (cond
  883.             ((eq chunk 'word)
  884.              (forward-word 1))
  885.             ((eq chunk 'line)
  886.              (end-of-line)))
  887.                (point))))))))
  888.     ;; Downcase the string if not supposed to case-fold yanked strings.
  889.     (if (and isearch-case-fold-search
  890.          (eq 'not-yanks search-upper-case))
  891.     (setq string (downcase string)))
  892.     (if isearch-regexp (setq string (regexp-quote string)))
  893.     (setq isearch-string (concat isearch-string string)
  894.       isearch-message
  895.       (concat isearch-message
  896.           (mapconcat 'isearch-text-char-description
  897.                  string ""))
  898.       ;; Don't move cursor in reverse search.
  899.       isearch-yank-flag t))
  900.   (isearch-search-and-update))
  901.  
  902. (defun isearch-yank-kill ()
  903.   "Pull string from kill ring into search string."
  904.   (interactive)
  905.   (isearch-yank 'kill))
  906.  
  907. (defun isearch-yank-word ()
  908.   "Pull next word from buffer into search string."
  909.   (interactive)
  910.   (isearch-yank 'word))
  911.  
  912. (defun isearch-yank-line ()
  913.   "Pull rest of line from buffer into search string."
  914.   (interactive)
  915.   (isearch-yank 'line))
  916.  
  917.  
  918. (defun isearch-search-and-update ()
  919.   ;; Do the search and update the display.
  920.   (if (and (not isearch-success)
  921.        ;; unsuccessful regexp search may become
  922.        ;;  successful by addition of characters which
  923.        ;;  make isearch-string valid
  924.        (not isearch-regexp))
  925.       nil
  926.     ;; In reverse search, adding stuff at
  927.     ;; the end may cause zero or many more chars to be
  928.     ;; matched, in the string following point.
  929.     ;; Allow all those possibilities without moving point as
  930.     ;; long as the match does not extend past search origin.
  931.     (if (and (not isearch-forward) (not isearch-adjusted)
  932.          (condition-case ()
  933.          (let ((case-fold-search isearch-case-fold-search))
  934.            (looking-at (if isearch-regexp isearch-string
  935.                  (regexp-quote isearch-string))))
  936.            (error nil))
  937.            (or isearch-yank-flag
  938.            (<= (match-end 0) 
  939.                (min isearch-opoint isearch-barrier))))
  940.     (setq isearch-success t 
  941.           isearch-invalid-regexp nil
  942.           isearch-within-brackets nil
  943.           isearch-other-end (match-end 0))
  944.       ;; Not regexp, not reverse, or no match at point.
  945.       (if (and isearch-other-end (not isearch-adjusted))
  946.       (goto-char (if isearch-forward isearch-other-end
  947.                (min isearch-opoint 
  948.                 isearch-barrier 
  949.                 (1+ isearch-other-end)))))
  950.       (isearch-search)
  951.       ))
  952.   (isearch-push-state)
  953.   (if isearch-op-fun (funcall isearch-op-fun))
  954.   (isearch-update))
  955.  
  956.  
  957. ;; *, ?, and | chars can make a regexp more liberal.
  958. ;; They can make a regexp match sooner or make it succeed instead of failing.
  959. ;; So go back to place last successful search started
  960. ;; or to the last ^S/^R (barrier), whichever is nearer.
  961. ;; + needs no special handling because the string must match at least once.
  962.  
  963. (defun isearch-*-char ()
  964.   "Handle * and ? specially in regexps."
  965.   (interactive)
  966.   (if isearch-regexp 
  967.  
  968.       (progn
  969.     (setq isearch-adjusted t)
  970.     (let ((cs (nth (if isearch-forward
  971.                5        ; isearch-other-end
  972.              2)        ; saved (point)
  973.                (car (cdr isearch-cmds)))))
  974.       ;; (car isearch-cmds) is after last search;
  975.       ;; (car (cdr isearch-cmds)) is from before it.
  976.       (setq cs (or cs isearch-barrier))
  977.       (goto-char
  978.        (if isearch-forward
  979.            (max cs isearch-barrier)
  980.          (min cs isearch-barrier))))))
  981.   (isearch-process-search-char (isearch-last-command-char)))
  982.   
  983.  
  984. (defun isearch-|-char ()
  985.   "If in regexp search, jump to the barrier."
  986.   (interactive)
  987.   (if isearch-regexp
  988.       (progn
  989.     (setq isearch-adjusted t)
  990.     (goto-char isearch-barrier)))
  991.   (isearch-process-search-char (isearch-last-command-char)))
  992.  
  993.  
  994. (defalias 'isearch-other-control-char 'isearch-other-meta-char)
  995.  
  996. (defun isearch-other-meta-char ()
  997.   "Exit the search normally and reread this key sequence.
  998. But only if `search-exit-option' is non-nil, the default.
  999. If it is the symbol `edit', the search string is edited in the minibuffer
  1000. and the meta character is unread so that it applies to editing the string."
  1001.   (interactive)
  1002.   (let* ((key (this-command-keys))
  1003.      (main-event (aref key 0))
  1004.      (keylist (listify-key-sequence key)))
  1005.     (cond ((and (= (length key) 1)
  1006.         (let ((lookup (lookup-key function-key-map key)))
  1007.           (not (or (null lookup) (integerp lookup)
  1008.                (keymapp lookup)))))
  1009.        ;; Handle a function key that translates into something else.
  1010.        ;; If the key has a global definition too,
  1011.        ;; exit and unread the key itself, so its global definition runs.
  1012.        ;; Otherwise, unread the translation,
  1013.        ;; so that the translated key takes effect within isearch.
  1014.        (cancel-kbd-macro-events)
  1015.        (if (lookup-key global-map key)
  1016.            (progn 
  1017.          (isearch-done)
  1018.          (apply 'isearch-unread keylist))
  1019.          (apply 'isearch-unread
  1020.             (listify-key-sequence (lookup-key function-key-map key)))))
  1021.       (
  1022.        ;; Handle an undefined shifted control character
  1023.        ;; by downshifting it if that makes it defined.
  1024.        ;; (As read-key-sequence would normally do,
  1025.        ;; if we didn't have a default definition.)
  1026.        (let ((mods (event-modifiers main-event)))
  1027.          (and (integerp main-event)
  1028.           (memq 'shift mods)
  1029.           (memq 'control mods)
  1030.           (lookup-key isearch-mode-map
  1031.                   (let ((copy (copy-sequence key)))
  1032.                 (aset copy 0
  1033.                       (- main-event (- ?\C-\S-a ?\C-a)))
  1034.                 copy)
  1035.                   nil)))
  1036.        (setcar keylist (- main-event (- ?\C-\S-a ?\C-a)))
  1037.        (cancel-kbd-macro-events)
  1038.        (apply 'isearch-unread keylist))
  1039.       ((eq search-exit-option 'edit)
  1040.        (apply 'isearch-unread keylist)
  1041.        (isearch-edit-string))
  1042.       (search-exit-option
  1043.        (let (window)
  1044.          (cancel-kbd-macro-events)
  1045.          (apply 'isearch-unread keylist)
  1046.          ;; Properly handle scroll-bar and mode-line clicks
  1047.          ;; for which a dummy prefix event was generated as (aref key 0).
  1048.          (and (> (length key) 1)
  1049.           (symbolp (aref key 0))
  1050.           (listp (aref key 1))
  1051.           (not (numberp (posn-point (event-start (aref key 1)))))
  1052.           ;; Convert the event back into its raw form,
  1053.           ;; with the dummy prefix implicit in the mouse event,
  1054.           ;; so it will get split up once again.
  1055.           (progn (setq unread-command-events
  1056.                    (cdr unread-command-events))
  1057.              (setq main-event (car unread-command-events))
  1058.              (setcar (cdr (event-start main-event))
  1059.                  (car (nth 1 (event-start main-event))))))
  1060.          ;; If we got a mouse click, maybe it was read with the buffer
  1061.          ;; it was clicked on.  If so, that buffer, not the current one,
  1062.          ;; is in isearch mode.  So end the search in that buffer.
  1063.          (if (and (listp main-event)
  1064.               (setq window (posn-window (event-start main-event)))
  1065.               (windowp window))
  1066.          (save-excursion
  1067.            (set-buffer (window-buffer window))
  1068.            (isearch-done))
  1069.            (isearch-done))))
  1070.       (t;; otherwise nil
  1071.        (isearch-process-search-string key key)))))
  1072.  
  1073. (defun isearch-quote-char ()
  1074.   "Quote special characters for incremental search."
  1075.   (interactive)
  1076.   (isearch-process-search-char (read-quoted-char (isearch-message t))))
  1077.  
  1078. (defun isearch-return-char ()
  1079.   "Convert return into newline for incremental search.
  1080. Obsolete."
  1081.   (interactive)
  1082.   (isearch-process-search-char ?\n))
  1083.  
  1084. (defun isearch-printing-char ()
  1085.   "Add this ordinary printing character to the search string and search."
  1086.   (interactive)
  1087.   (isearch-process-search-char (isearch-last-command-char)))
  1088.  
  1089. (defun isearch-whitespace-chars ()
  1090.   "Match all whitespace chars, if in regexp mode.
  1091. If you want to search for just a space, type C-q SPC."
  1092.   (interactive)
  1093.   (if isearch-regexp 
  1094.       (if (and search-whitespace-regexp (not isearch-within-brackets)
  1095.            (not isearch-invalid-regexp))
  1096.       (isearch-process-search-string search-whitespace-regexp " ")
  1097.     (isearch-printing-char))
  1098.     (progn
  1099.       ;; This way of doing word search doesn't correctly extend current search.
  1100.       ;;      (setq isearch-word t)
  1101.       ;;      (setq isearch-adjusted t)
  1102.       ;;      (goto-char isearch-barrier)
  1103.       (isearch-printing-char))))
  1104.  
  1105. (defun isearch-process-search-char (char)
  1106.   ;; Append the char to the search string, update the message and re-search.
  1107.   (isearch-process-search-string 
  1108.    (isearch-char-to-string char) 
  1109.    (isearch-text-char-description char)))
  1110.  
  1111. (defun isearch-process-search-string (string message)
  1112.   (setq isearch-string (concat isearch-string string)
  1113.     isearch-message (concat isearch-message message))
  1114.   (isearch-search-and-update))
  1115.  
  1116.  
  1117. ;; Search Ring
  1118.  
  1119. (defun isearch-ring-adjust1 (advance)
  1120.   ;; Helper for isearch-ring-adjust
  1121.   (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
  1122.      (length (length ring))
  1123.      (yank-pointer-name (if isearch-regexp
  1124.                 'regexp-search-ring-yank-pointer
  1125.                   'search-ring-yank-pointer))
  1126.      (yank-pointer (eval yank-pointer-name)))
  1127.     (if (zerop length)
  1128.     ()
  1129.       (set yank-pointer-name
  1130.        (setq yank-pointer
  1131.          (mod (+ (or yank-pointer 0)
  1132.              (if advance -1 1))
  1133.               length)))
  1134.       (setq isearch-string (nth yank-pointer ring)
  1135.         isearch-message (mapconcat 'isearch-text-char-description
  1136.                        isearch-string "")))))
  1137.  
  1138. (defun isearch-ring-adjust (advance)
  1139.   ;; Helper for isearch-ring-advance and isearch-ring-retreat
  1140.   (if (cdr isearch-cmds)  ;; is there more than one thing on stack?
  1141.       (isearch-pop-state))
  1142.   (isearch-ring-adjust1 advance)
  1143.   (isearch-push-state)
  1144.   (if search-ring-update
  1145.       (progn
  1146.     (isearch-search)
  1147.     (isearch-update))
  1148.     (isearch-edit-string)
  1149.     ))
  1150.  
  1151. (defun isearch-ring-advance ()
  1152.   "Advance to the next search string in the ring."
  1153.   ;; This could be more general to handle a prefix arg, but who would use it.
  1154.   (interactive)
  1155.   (isearch-ring-adjust 'advance))
  1156.  
  1157. (defun isearch-ring-retreat ()
  1158.   "Retreat to the previous search string in the ring."
  1159.   (interactive)
  1160.   (isearch-ring-adjust nil))
  1161.  
  1162. (defun isearch-ring-advance-edit (n)
  1163.   "Insert the next element of the search history into the minibuffer."
  1164.   (interactive "p")
  1165.   (let* ((yank-pointer-name (if isearch-regexp
  1166.                 'regexp-search-ring-yank-pointer
  1167.                   'search-ring-yank-pointer))
  1168.      (yank-pointer (eval yank-pointer-name))
  1169.      (ring (if isearch-regexp regexp-search-ring search-ring))
  1170.      (length (length ring)))
  1171.     (if (zerop length)
  1172.     ()
  1173.       (set yank-pointer-name
  1174.        (setq yank-pointer
  1175.          (mod (- (or yank-pointer 0) n)
  1176.               length)))
  1177.  
  1178.       (erase-buffer)
  1179.       (insert (nth yank-pointer ring))
  1180.       (goto-char (point-max)))))
  1181.  
  1182. (defun isearch-ring-retreat-edit (n)
  1183.   "Inserts the previous element of the search history into the minibuffer."
  1184.   (interactive "p")
  1185.   (isearch-ring-advance-edit (- n)))
  1186.  
  1187. ;;(defun isearch-ring-adjust-edit (advance)
  1188. ;;  "Use the next or previous search string in the ring while in minibuffer."
  1189. ;;  (isearch-ring-adjust1 advance)
  1190. ;;  (erase-buffer)
  1191. ;;  (insert isearch-string))
  1192.  
  1193. ;;(defun isearch-ring-advance-edit ()
  1194. ;;  (interactive)
  1195. ;;  (isearch-ring-adjust-edit 'advance))
  1196.  
  1197. ;;(defun isearch-ring-retreat-edit ()
  1198. ;;  "Retreat to the previous search string in the ring while in the minibuffer."
  1199. ;;  (interactive)
  1200. ;;  (isearch-ring-adjust-edit nil))
  1201.  
  1202.  
  1203. (defun isearch-complete1 ()
  1204.   ;; Helper for isearch-complete and isearch-complete-edit
  1205.   ;; Return t if completion OK, nil if no completion exists.
  1206.   (let* ((ring (if isearch-regexp regexp-search-ring search-ring))
  1207.          (alist (mapcar (function (lambda (string) (list string))) ring))
  1208.          (completion-ignore-case case-fold-search)
  1209.          (completion (try-completion isearch-string alist)))
  1210.     (cond
  1211.      ((eq completion t)
  1212.       ;; isearch-string stays the same
  1213.       t)
  1214.      ((or completion ; not nil, must be a string
  1215.       (= 0 (length isearch-string))) ; shouldn't have to say this
  1216.       (if (equal completion isearch-string)  ;; no extension?
  1217.       (if completion-auto-help
  1218.           (with-output-to-temp-buffer "*Isearch completions*"
  1219.         (display-completion-list 
  1220.          (all-completions isearch-string alist))))
  1221.     (setq isearch-string completion))
  1222.       t)
  1223.      (t
  1224.       (message "No completion") ; waits a second if in minibuffer
  1225.       nil))))
  1226.  
  1227. (defun isearch-complete ()
  1228.   "Complete the search string from the strings on the search ring.
  1229. The completed string is then editable in the minibuffer.
  1230. If there is no completion possible, say so and continue searching."
  1231.   (interactive)
  1232.   (if (isearch-complete1)
  1233.       (isearch-edit-string)
  1234.     ;; else
  1235.     (sit-for 1)
  1236.     (isearch-update)))
  1237.  
  1238. (defun isearch-complete-edit ()
  1239.   "Same as `isearch-complete' except in the minibuffer."
  1240.   (interactive)
  1241.   (setq isearch-string (buffer-string))
  1242.   (if (isearch-complete1)
  1243.       (progn
  1244.     (erase-buffer)
  1245.     (insert isearch-string))))
  1246.  
  1247.  
  1248. ;; The search status stack (and isearch window-local variables, not used).
  1249. ;; Need a structure for this.
  1250.  
  1251. (defun isearch-top-state ()
  1252.   (let ((cmd (car isearch-cmds)))
  1253.     (setq isearch-string (car cmd)
  1254.       isearch-message (car (cdr cmd))
  1255.       isearch-success (nth 3 cmd)
  1256.       isearch-forward (nth 4 cmd)
  1257.       isearch-other-end (nth 5 cmd)
  1258.       isearch-word (nth 6 cmd)
  1259.       isearch-invalid-regexp (nth 7 cmd)
  1260.       isearch-wrapped (nth 8 cmd)
  1261.       isearch-barrier (nth 9 cmd)
  1262.       isearch-within-brackets (nth 10 cmd)
  1263.       isearch-case-fold-search (nth 11 cmd))
  1264.     (goto-char (car (cdr (cdr cmd))))))
  1265.  
  1266. (defun isearch-pop-state ()
  1267.   (setq isearch-cmds (cdr isearch-cmds))
  1268.   (isearch-top-state)
  1269.   )
  1270.  
  1271. (defun isearch-push-state ()
  1272.   (setq isearch-cmds 
  1273.     (cons (list isearch-string isearch-message (point)
  1274.             isearch-success isearch-forward isearch-other-end 
  1275.             isearch-word
  1276.             isearch-invalid-regexp isearch-wrapped isearch-barrier
  1277.             isearch-within-brackets isearch-case-fold-search)
  1278.           isearch-cmds)))
  1279.  
  1280.  
  1281. ;; Message string
  1282.  
  1283. (defun isearch-message (&optional c-q-hack ellipsis)
  1284.   ;; Generate and print the message string.
  1285.   (let ((cursor-in-echo-area ellipsis)
  1286.     (m (concat
  1287.         (isearch-message-prefix c-q-hack ellipsis isearch-nonincremental)
  1288.         isearch-message
  1289.         (isearch-message-suffix c-q-hack ellipsis)
  1290.         )))
  1291.     (if c-q-hack
  1292.     m
  1293.       (let ((message-log-max nil))
  1294.     (message "%s" m)))))
  1295.  
  1296. (defun isearch-message-prefix (&optional c-q-hack ellipsis nonincremental)
  1297.   ;; If about to search, and previous search regexp was invalid,
  1298.   ;; check that it still is.  If it is valid now,
  1299.   ;; let the message we display while searching say that it is valid.
  1300.   (and isearch-invalid-regexp ellipsis
  1301.        (condition-case ()
  1302.        (progn (re-search-forward isearch-string (point) t)
  1303.           (setq isearch-invalid-regexp nil
  1304.             isearch-within-brackets nil))
  1305.      (error nil)))
  1306.   ;; If currently failing, display no ellipsis.
  1307.   (or isearch-success (setq ellipsis nil))
  1308.   (let ((m (concat (if isearch-success "" "failing ")
  1309.            (if (and isearch-wrapped
  1310.                 (if isearch-forward
  1311.                 (> (point) isearch-opoint)
  1312.                   (< (point) isearch-opoint)))
  1313.                "over")
  1314.            (if isearch-wrapped "wrapped ")
  1315.            (if isearch-word "word " "")
  1316.            (if isearch-regexp "regexp " "")
  1317.            (if nonincremental "search" "I-search")
  1318.            (if isearch-forward ": " " backward: ")
  1319.            )))
  1320.     (aset m 0 (upcase (aref m 0)))
  1321.     m))
  1322.  
  1323.  
  1324. (defun isearch-message-suffix (&optional c-q-hack ellipsis)
  1325.   (concat (if c-q-hack "^Q" "")
  1326.       (if isearch-invalid-regexp
  1327.           (concat " [" isearch-invalid-regexp "]")
  1328.         "")))
  1329.  
  1330.  
  1331. ;;; Searching
  1332.  
  1333. (defun isearch-search ()
  1334.   ;; Do the search with the current search string.
  1335.   (isearch-message nil t)
  1336.   (if (and (eq isearch-case-fold-search t) search-upper-case)
  1337.       (setq isearch-case-fold-search
  1338.         (isearch-no-upper-case-p isearch-string isearch-regexp)))
  1339.   (condition-case lossage
  1340.       (let ((inhibit-quit nil)
  1341.         (case-fold-search isearch-case-fold-search))
  1342.     (if isearch-regexp (setq isearch-invalid-regexp nil))
  1343.     (setq isearch-within-brackets nil)
  1344.     (setq isearch-success
  1345.           (funcall
  1346.            (cond (isearch-word
  1347.               (if isearch-forward
  1348.               'word-search-forward 'word-search-backward))
  1349.              (isearch-regexp
  1350.               (if isearch-forward
  1351.               're-search-forward 're-search-backward))
  1352.              (t
  1353.               (if isearch-forward 'search-forward 'search-backward)))
  1354.            isearch-string nil t))
  1355.     (setq isearch-just-started nil)
  1356.     (if isearch-success
  1357.         (setq isearch-other-end
  1358.           (if isearch-forward (match-beginning 0) (match-end 0)))))
  1359.  
  1360.     (quit (isearch-unread ?\C-g)
  1361.       (setq isearch-success nil))
  1362.  
  1363.     (invalid-regexp 
  1364.      (setq isearch-invalid-regexp (car (cdr lossage)))
  1365.      (setq isearch-within-brackets (string-match "\\`Unmatched \\["
  1366.                          isearch-invalid-regexp))
  1367.      (if (string-match
  1368.       "\\`Premature \\|\\`Unmatched \\|\\`Invalid "
  1369.       isearch-invalid-regexp)
  1370.      (setq isearch-invalid-regexp "incomplete input")))
  1371.     (error
  1372.      ;; stack overflow in regexp search.
  1373.      (setq isearch-invalid-regexp (car (cdr lossage)))))
  1374.  
  1375.   (if isearch-success
  1376.       nil
  1377.     ;; Ding if failed this time after succeeding last time.
  1378.     (and (nth 3 (car isearch-cmds))
  1379.      (ding))
  1380.     (goto-char (nth 2 (car isearch-cmds)))))
  1381.  
  1382.  
  1383.  
  1384. ;;; Highlighting
  1385.  
  1386. (defvar isearch-overlay nil)
  1387.  
  1388. (defun isearch-highlight (beg end)
  1389.   (if (or (null search-highlight) (null window-system))
  1390.       nil
  1391.     (or isearch-overlay (setq isearch-overlay (make-overlay beg end)))
  1392.     (move-overlay isearch-overlay beg end (current-buffer))
  1393.     (overlay-put isearch-overlay 'face
  1394.          (if (internal-find-face 'isearch nil)
  1395.              'isearch 'region))))
  1396.  
  1397. (defun isearch-dehighlight (totally)
  1398.   (if isearch-overlay
  1399.       (delete-overlay isearch-overlay)))
  1400.  
  1401. ;;; General utilities
  1402.  
  1403.  
  1404. (defun isearch-no-upper-case-p (string regexp-flag)
  1405.   "Return t if there are no upper case chars in STRING.
  1406. If REGEXP-FLAG is non-nil, disregard letters preceded by `\\' (but not `\\\\')
  1407. since they have special meaning in a regexp."
  1408.   (let ((case-fold-search nil))
  1409.     (not (string-match (if regexp-flag "\\(^\\|\\\\\\\\\\|[^\\]\\)[A-Z]"
  1410.              "[A-Z]")
  1411.                string))))
  1412.  
  1413.  
  1414. ;; Portability functions to support various Emacs versions.
  1415.  
  1416. ;; To quiet the byte-compiler.
  1417. (defvar unread-command-event)
  1418. (defvar unread-command-events)
  1419. (defvar last-command-event)
  1420.  
  1421. (defun isearch-char-to-string (c)
  1422.   (make-string 1 c))
  1423.  
  1424. (defun isearch-text-char-description (c)
  1425.   (if (and (integerp c) (or (< c ?\ ) (= c ?\^?)))
  1426.       (text-char-description c)
  1427.     (isearch-char-to-string c)))
  1428.  
  1429. ;; General function to unread characters or events.
  1430. ;; Also insert them in a keyboard macro being defined.
  1431. (defun isearch-unread (&rest char-or-events)
  1432.   (mapcar 'store-kbd-macro-event char-or-events)
  1433.   (setq unread-command-events
  1434.     (append char-or-events unread-command-events)))
  1435.  
  1436. (defun isearch-last-command-char ()
  1437.   ;; General function to return the last command character.
  1438.   last-command-char)
  1439.  
  1440. ;;; isearch.el ends here
  1441.